Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix link of "Building for Relative Paths" #12691

Merged
merged 2 commits into from
Sep 8, 2022
Merged

docs: fix link of "Building for Relative Paths" #12691

merged 2 commits into from
Sep 8, 2022

Conversation

jackblackevo
Copy link
Contributor

Add the missing .md to fix link of "Building for Relative Paths"

@jackblackevo jackblackevo requested a review from mrmckeb as a code owner August 25, 2022 18:58
@facebook-github-bot
Copy link

Hi @jackblackevo!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@jesec
Copy link

jesec commented Aug 30, 2022

Docs are deployed via Docusaurus.

See https://create-react-app.dev/docs/advanced-configuration for the deployed page of the file referred in this PR.

Users would get 404 if .md is appended. I understand that the experience may not be optimal for users who browse the docs on GitHub, but there doesn't seem to be a perfect way at the moment.

@jackblackevo
Copy link
Contributor Author

Hi @jesec!
Thanks for your reminder.

I checked the Docusaurus document:

If you want to reference another Markdown file included by the same plugin, you could use the relative path of the document you want to link to. Docusaurus' Markdown loader will convert the file path to the target file's URL path (and hence remove the .md extension).

-- https://docusaurus.io/docs/markdown-features/links

Then I checked another link which reference to another document on this page, such as the ".env" link:

create-react-app/docusaurus/docs/advanced-configuration.md

Line 6 in f34d88e

You can adjust various development and production settings by setting environment variables in your shell or with [.env](adding-custom-environment-variables.md#adding-development-environment-variables-in-env).

image

The file path above is included .md, and user can link to target document page.

But in that case below:

create-react-app/docusaurus/docs/advanced-configuration.md

Line 20 in f34d88e

| PUBLIC_URL | ✅ Used | ✅ Used | Create React App assumes your application is hosted at the serving web server's root or a subpath as specified in [`package.json` (`homepage`)](deployment#building-for-relative-paths). Normally, Create React App ignores the hostname. You may use this variable to force assets to be referenced verbatim to the url you provide (hostname included). This may be particularly useful when using a CDN to host your application. |

image

The file path not included .md which make user get wrong URL (404).

jesec
jesec suggested changes Sep 7, 2022
View reviewed changes
Copy link

@jesec jesec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-formatting is required. See https://github.com/facebook/create-react-app/runs/8218127528.

Otherwise, lg2m.

@jackblackevo
Copy link
Contributor Author

Thank you @jesec!
I formated the file to fix that lint error.

@jackblackevo jackblackevo requested review from jesec and removed request for mrmckeb September 7, 2022 07:15
@jesec jesec merged commit d960b9e into facebook:main Sep 8, 2022
Mr-Dy986 added a commit to Mr-Dy986/create-react-app that referenced this pull request Oct 9, 2022
@Mr-Dy986
docs: fix link of "Building for Relative Paths" (facebook#12691)
791ecb3 
<!--
Thank you for sending the PR!

If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots!

Happy contributing!
-->
Mr-Dy986 added a commit to Mr-Dy986/create-react-app that referenced this pull request Oct 9, 2022
@Mr-Dy986
Merge pull request #1 from Mr-Dy986:create-react-app
7496d25 
docs: fix link of "Building for Relative Paths" (facebook#12691)
Mr-Dy986 added a commit to Mr-Dy986/create-react-app that referenced this pull request Oct 9, 2022
@Mr-Dy986
docs: fix link of "Building for Relative Paths" (facebook#12691)
8f83fe3 
<!--
Thank you for sending the PR!

If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots!

Happy contributing!
-->

<!--
Thank you for sending the PR!

If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots!

Happy contributing!
-->
Mr-Dy986 added a commit to Mr-Dy986/create-react-app that referenced this pull request Oct 9, 2022
@Mr-Dy986
Merge pull request #2 from Mr-Dy986:create-react-app
f3dc503 
docs: fix link of "Building for Relative Paths" (facebook#12691)
unional pushed a commit to unional/create-react-app that referenced this pull request Feb 21, 2024
@jackblackevo @unional
docs: fix link of "Building for Relative Paths" (facebook#12691)
85533ba
@bulutuu
Copy link

bulutuu commented Apr 28, 2024

Hi @jackblackevo!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@bulutuu bulutuu mentioned this pull request Apr 28, 2024
Open
@bulutuu
Copy link

bulutuu commented Apr 28, 2024

Docs are deployed via Docusaurus.

See https://create-react-app.dev/docs/advanced-configuration for the deployed page of the file referred in this PR.

Users would get 404 if .md is appended. I understand that the experience may not be optimal for users who browse the docs on GitHub, but there doesn't seem to be a perfect way at the moment.

@bulutuu
Copy link

bulutuu commented Apr 28, 2024

Re-formatting is required. See https://github.com/facebook/create-react-app/runs/8218127528.

Otherwise, lg2m.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jesec jesec jesec approved these changes

Assignees
No one assigned
Labels
CLA Signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jackblackevo @facebook-github-bot @jesec @bulutuu